Skip to content

Comments

Add monitoring for model manager#37703

Draft
AMOOOMA wants to merge 4 commits intoapache:masterfrom
AMOOOMA:monitoring
Draft

Add monitoring for model manager#37703
AMOOOMA wants to merge 4 commits intoapache:masterfrom
AMOOOMA:monitoring

Conversation

@AMOOOMA
Copy link
Contributor

@AMOOOMA AMOOOMA commented Feb 24, 2026

Export memory estimate and model count per model tag to apache beam Metrics
This is exported to process wide container so UW harness can read it and export to cloud monitoring later.

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Feb 24, 2026

Summary of Changes

Hello @AMOOOMA, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the Apache Beam Model Manager by introducing comprehensive monitoring capabilities. It exports critical operational metrics, specifically memory estimates and the count of loaded models per tag, to the Apache Beam Metrics system. These process-wide metrics provide valuable insights into the model manager's resource utilization and model lifecycle, facilitating better observability and integration with external monitoring tools.

Highlights

  • Process-Wide Gauge Metrics: Extended the Metrics.gauge method to support process_wide metrics, allowing gauges to be calculated for the entire process rather than just the current bundle.
  • Model Memory Estimate Monitoring: Integrated Metrics.gauge calls into the ModelManager to export the memory estimate (in MB) for each model tag as a process-wide metric, updated during initial estimation and subsequent re-estimations.
  • Loaded Model Count Monitoring: Added new methods (_update_model_count_metric, _clear_all_model_metrics) and integrated Metrics.gauge calls to track and export the number of loaded models per tag as a process-wide metric. This count is updated when models are spawned, evicted, or all models are deleted.
  • Unit Test Coverage: Included a new unit test (test_model_manager_metric_gauge) to verify the correct functionality and updates of the newly added model manager metrics.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • sdks/python/apache_beam/metrics/metric.py
    • Added a process_wide parameter to the Metrics.gauge static method.
    • Modified the DelegatingGauge constructor to accept and pass the process_wide argument to MetricUpdater.
  • sdks/python/apache_beam/ml/inference/model_manager.py
    • Imported the Metrics module.
    • Added Metrics.gauge calls to set_initial_estimate and _solve to report memory_estimate_mb for each model tag.
    • Introduced _update_model_count_metric to report the number of loaded models per tag.
    • Introduced _clear_all_model_metrics to reset model count metrics when all models are deleted.
    • Integrated calls to _update_model_count_metric within _perform_eviction and _spawn_new_model.
    • Integrated a call to _clear_all_model_metrics within _delete_all_models.
  • sdks/python/apache_beam/ml/inference/model_manager_test.py
    • Imported MetricsEnvironment and MetricName for testing metrics.
    • Added a new test method test_model_manager_metric_gauge to validate the accuracy of model manager memory estimate and loaded model count metrics.
Activity
  • No specific human activity (comments, reviews, etc.) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@AMOOOMA